/*
 * #%L
 * Server
 * %%
 * Copyright (C) 2011 Ractoc.com
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package com.ractoc.opengamefinder.server.plugins.messages;

import com.ractoc.pffj.api.BasePluginMessage;

/**
 * This message is used to send the actual message, the payload, to another
 * server plugin. By using this message instead of just sending the base
 * message, it is possible to also always send the session id. Which is needed
 * by the other plugins to access the session data.
 * 
 * @author ractoc
 * @version 0.1
 */
public final class ServerMessage extends BasePluginMessage {

    private Integer sessionId;

    private BasePluginMessage payload;

    /**
     * Default constructor.
     */
    public ServerMessage() {
    }

    /**
     * Set the current session id.
     * @param sessionIdParam The current session id.
     */
    public void setSessionId(final Integer sessionIdParam) {
        this.sessionId = sessionIdParam;
    }

    /**
     * Get the current session id.
     * @return The current session id.
     */
    public Integer getSessionId() {
        return sessionId;
    }

    /**
     * Set the actual message.
     * @param payloadParam The actual message.
     */
    public void setPayload(final BasePluginMessage payloadParam) {
        this.payload = payloadParam;
    }

    /**
     * Get the actual message.
     * @return The actual message.
     */
    public BasePluginMessage getPayload() {
        return payload;
    }

}
